
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>lmp.entrainment &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="lmp.track_particles" href="lmp.track_particles.html" />
    <link rel="prev" title="lmp.correct_particle_tracking" href="lmp.correct_particle_tracking.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="lmp-entrainment">
<h1>lmp.entrainment<a class="headerlink" href="#lmp-entrainment" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="lmp.entrainment">
<code class="sig-prename descclassname">lmp.</code><code class="sig-name descname">entrainment</code><span class="sig-paren">(</span><em class="sig-param">q0_local</em>, <em class="sig-param">q1_local</em>, <em class="sig-param">p</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/lmp.html#entrainment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#lmp.entrainment" title="Permalink to this definition">¶</a></dt>
<dd><p>Compute the total shear and forced entrainment at one time step</p>
<p>Computes the local entrainment (kg/s) as a combination of shear
entrainment and forced entrainment for a local Lagrangian element. This
function follows the approach in Lee and Cheung (1990) to compute both
types of entrainment, but uses the formulation in Jirka (2004) for the
shear entrainment term. Like Lee and Cheung (1990), it uses the maximum
entrainment hypothesis: entrainment = max (shear, forced), with the
exception that a pure coflowing momentum jet has entrainment = shear +
forced. This function also makes one correction that in pure coflow
the forced entrainment should be computed by integrating around the entire
jet, and not just the half of the jet exposed to the current.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>q0_local</strong><span class="classifier"><cite>bent_plume_model.LagElement</cite></span></dt><dd><p>Object containing the numerical solution at the previous time step</p>
</dd>
<dt><strong>q1_local</strong><span class="classifier"><cite>bent_plume_model.LagElement</cite></span></dt><dd><p>Object containing the numerical solution at the current time step</p>
</dd>
<dt><strong>p</strong><span class="classifier"><cite>ModelParams</cite> object</span></dt><dd><p>Object containing the fixed model parameters for the bent
plume model.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt><strong>md</strong><span class="classifier">float</span></dt><dd><p>Total entrainment (kg/s)</p>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The entrainment computed here is already integrated over the current 
Lagrangian element surface area.  Hence, the result is (kg/s) into the 
element.</p>
</dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../../user_manual.html">TAMOC User Manual</a><ul>
  <li><a href="../../modules/bpm.html">Overview of Bent Plume Model Module</a><ul>
      <li>Previous: <a href="lmp.correct_particle_tracking.html" title="previous chapter">lmp.correct_particle_tracking</a></li>
      <li>Next: <a href="lmp.track_particles.html" title="next chapter">lmp.track_particles</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../_sources/autodoc/bpm/lmp.entrainment.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>